/* Copyright (c) 2007 - 2011, Christian Hujer
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the AceUnit developers nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package net.sf.aceunit;

import net.sf.aceunit.util.IdGenerator;
import org.jetbrains.annotations.NotNull;

/**
 * A test, which can be anything that actually is a Test.
 *
 * @author <a href="mailto:cher@riedquat.de">Christian Hujer</a>
 */
public abstract class Test {

    /**
     * The name of this Test.
     */
    private final String name;
    /**
     * The id of this Test.
     */
    private int id;

    /**
     * Creates a Test.
     *
     * @param name The name of this test.
     */
    protected Test(@NotNull final String name) {
        this.name = name;
    }

    /**
     * Returns the name of this test.
     *
     * @return The name of this test.
     */
    public String getName() {
        return name;
    }

    /**
     * Returns the id of this Test.
     *
     * @return The id of this Test.
     * @throws IllegalStateException in case the id is not yet set.
     */
    public int getId() throws IllegalStateException {
        if (id == 0) {
            throw new IllegalStateException("Id not yet set.");
        }
        return id;
    }

    /**
     * Sets the id of this test (recursively).
     *
     * @param generator IdGenerator from which the id to set is retrieved.
     * @throws IllegalStateException in case the id is already set.
     * @note Because of the recursive behaviour, the generator might be used more than once.
     */
    public void setId(@NotNull final IdGenerator generator) throws IllegalStateException {
        if (id != 0) {
            throw new IllegalStateException("Id already set.");
        }
        id = generator.getNextId();
    }

}
